This document provides an overview of the CMP 8.13 release with specific focus on the additional functional and non-functional enhancements with respect to CMP 8.12.
This document is aimed at internal and external audiences familiar with CMP, to explain the key features of the release including any changes in how existing functions or processes are working.
With respect to CMP 8.12, CMP 8.13 introduces changes to existing functionality and non-functional improvements. These changes can be summarised as follows:
When an account balance is written off as the last action of a Credit Control procedure, CMP 8.13 will now automatically mark the identity associated with the account as blacklisted. The account and any subscriptions using the same identity will be shown as blacklisted in AgentView. Whilst an identity is marked as blacklisted, no entities can be created in CMP (account or subscription) using the same blacklisted identity. A privileged agent can bring an identity out of the blacklist if required. Further details can be found in section 3.1.2.1 below.
A new bulk action has been introduced in CMP 8.13 to support the addition of a zero-priced, non-recurring package to multiple subscriptions. Like other bulk actions, the Add Package bulk action is driven by a spreadsheet of subscriptions to add the package to.
In addition to changes to support the Identity Management feature, the currency used for billing the account has been added to the Account Summary top panel.
In CMP 8.13, the AddRegisteredCard SOAP web service has been updated to allow a previously cancelled card to be reinstated.
CMP 8.13 introduces two new web services to add an email address to both an account and a subscription. These are POST Account Email Address and POST Subscription Email Address respectively.
In addition , the GET Account web service now supports an additional embedded object of address allowing the account address details to be returned as part of the response.
The responses of the GET Accounts, GET Account, GET Subscriptions and GET Subscription web services have been updated to include information on the customer identity.
The POST Registered Card web service now allows a previously cancelled card to be reinstated.
The POST Order web service now supports an upgrade order where a price plan change and/or a number change can be requested. In addition, it is now possible to supply one or more non-managed serial numbers as part of a new subscription and an upgrade order. Non-managed serial numbers can also now be added as part of the POST Subscription request.
The response of the GET Order web service has been updated to return the deviceEnrolmentStatus.
The response of the GET Subscription web service has been updated to return a salesperson object and an indication of whether the subscriber has an eSIM provisioned and if so, what the status of that eSIM is.
The POST Subscription Attributes web service has been updated to now allow the specification of multiple attributes rather than just one.
Additional changes to the PATCH Subscription Email Address, POST Payment, PATCH Price Plan and the PATCH Serial Numbers web service have been made in CMP 8.13, details of which can be found below.
In CMP 8.13, the Managed Number Monitor job has been enhanced to return numbers that are marked as SELECTED, and that are not allocated to a subscription, to the available number pool. The Workflow Monitor job has been enhanced in CMP 8.13 to support the blacklisting of identity numbers as the final part of the Credit Control process when an account balance is written-off. The Action Monitor job has been enhanced to set the bar/unbar reason code on the Subscription Bar record to the reason code of the Workflow Event relating to the action item being confirmed. The Order Dispatch job has been enhanced to take into consideration how a subscription chooses to pay for the handset, for example, pay in full on a CMP invoice or over the course of their contract.
The functional and non-functional changes highlighted in section 2 above have had an impact CMP in the following areas:
No new screens have been introduced as part of CMP 8.13.
As described in section 2.1.1 above, CMP 8.13 introduces the ability to blacklist a customer identity as part of Credit Control. This has resulted in a number of changes to AgentView screens that are described below.
When an identity is blacklisted, then the account, and any subscriptions using the same identity, will be blacklisted. This is indicated on the account icon on the Account Summary screen.
When a subscription uses an identity that is marked as blacklisted the subscription icon on the Subscription Summary screen now indicates this.
If an attempt is made to create an account through the Account Creation Wizard with an identity number that is currently marked as blacklisted, then in CMP 8.13, when the identity number is entered, a warning message will be displayed to the AgentView user and the account installation will not be allowed to proceed. Similarly, if an attempt is made to create a subscription under an account with a blacklisted identity, then the subscription creation will be prevented.
The Personal Address popup shows the identity of the customer associated with the address. With the introduction of Identity Management in CMP 8.13, the popup now shows a checkbox next to the identity number field. If the identity is marked as blacklisted then the number will be read-only and the 'Override' checkbox will be enabled. It is possible for an AgentView user to bring an identity out of blacklisting by checking the override checkbox.
The Account Summary screen has also been updated for CMP 8.13 to show the billing currency of the account.
A new bulk action has been introduced in CMP 8.13 to support the addition of a zero-priced, non-recurring package to multiple subscriptions.
The Excel spreadsheet template provided must be populated with an identifier to identify the subscriptions to which the bulk service change will apply. This can be either an MSISDN or a subscription number. Once the template spreadsheet has been populated with the subscriptions to have the package added, then the Add Package bulk action wizard can be used to process the file. From here the package to be added can be selected from those available in the Package Code dropdown and a date selected as to when the package is to start.
The user requires the WSO2 role bulk-add-package to be able to see the bulk action template and menu option in the Bulk Action Console.
No Bulk Actions have been changed for CMP 8.13.
No new jobs or daemons have been added for CMP 8.13.
Tooltip text in the following modules has been added to properties where no tooltip text was available in CMP 8.12:
In addition, some of the module transaction timeouts have been hidden to simplify the presentation of the module properties. Transaction timeouts are not typically something that would be changed from their configured default value.
The sabre-recurring-bank-payments-bacs-adapter has been deprecated in CMP 8.13 See section 3.12 below.
The CMP 8.13 release has improved the level of descriptive information provided for a number of the daemons available. The information has been broken down into the following sections:
The following modules have been enhanced to provide further business and operational information for the associated daemons:
Managed serial numbers progress through a series of states as they progress through a subscription's registration process. One of those states is SELECTED. In CMP 8.12, if a number was marked as SELECTED, using the PATCH Serial Number API, then it would remain in that state as the Managed Number Monitor job did not consider SELECTED numbers.
In CMP 8.13, the Managed Number Monitor job now considers numbers marked as SELECTED when returning numbers to the available number pool. Only SELECTED numbers that are not allocated to a subscription will be made available again. If the number was previously allocated to a dealer then this association will remain when the number status is updated.
The Workflow Monitor job has been enhanced in CMP 8.13 to support the blacklisting of identity numbers as part of the Credit Control process. When an account balance is written-off as part of Credit Control, the identity associated with the account will be marked as blacklisted. All subscriptions using the same identity, whether under the same account structure or not, will also be marked as blacklisted.
In CMP 8.12, any reason code that was associated with a subscription bar was not being set correctly so that it wasn't easy to understand the reason behind a bar being applied. In CMP 8.13, when confirming a successful bar action item, the Action Monitor job sets the bar reason code on the Subscription Bar record to the reason code of the Workflow Event relating to the action item being confirmed. Similarly, when confirming a successful unbar action item, the Action Monitor job sets the unbar reason code on the Subscription Bar record to the reason code of the Workflow Event record relating to the action item being confirmed.
Additionally, Action Monitor has been enhanced to take into consideration subscription upgrades that are associated with an order i.e. change price plan and ordering hardware at the same time. In this scenario, there may be an upfront cost for the handset plus a regular instalment amount that is payable over the course of the subscription's contract.
In CMP 8.13, the Order Dispatch job has been enhanced to take into consideration how a subscription chooses to pay for the handset. This could be in full/part outside of CMP for example, or they can choose to pay in full on a CMP invoice or over the course of their contract.
The Order Dispatch job has also been enhanced to take serial numbers into consideration when, for example, the warehouse may supply a SIM card with a paired MSISDN. These are updated on the subscription as part of the order dispatch.
In addition, it is now possible to generate an outbound customer communication when an order is dispatched from the warehouse (see the additional configuration required to support this below).
No changes have been made to any of the options within the System Management menu option in CMP 8.13.
No changes have been made to any of the options within the System Monitoring menu option in CMP 8.13.
No changes have been made to any of the options within the System Configuration menu option in CMP 8.13.
No changes have been made to any of the options within the System Administrator menu option in CMP 8.13.
No new Business Configuration screens have been introduced as part of the CMP 8.13 release.
No Business Configuration screens have been changed as part of the CMP 8.13 release.
There are no new Pricing Configuration screens that have been introduced as part of CMP 8.13.
No Pricing Configuration screens have been changed as part of CMP 8.13.
No new SOAP web services have been introduced as part of the CMP 8.13 release.
In CMP 8.12, the AddRegisteredCard SOAP web service prevented a card from being added in CMP if the card token supplied in the request was already registered in CMP. In CMP 8.13, the web service has been updated to allow a card with a token already registered in CMP to be added if the token is associated with a cancelled card that has the same card details as those provided in the request. This allows a previously cancelled card to be reinstated.
A new POST Account Email Address web service has been added to support the addition of an email address to a specific account.
A new POST Subscription Email Address web service has been added to support the addition of an email address to a specific subscription.
The GET Account web service request has been updated to support an additional embedded object of address allowing the account address details to be returned as part of the response.
The web service response has been updated to return the identity held against the personal address of the account. The identification object also contains information on when the identity was last blacklisted and/or whitelisted.
In a similar way to the GET Account response update, the GET Accounts web service response has also been updated to return the identity held against the personal address of each of the accounts returned.
In CMP 8.12, the Add Registered Card web service prevented a card from being added in CMP if the card token supplied in the request was already registered in CMP. In CMP 8.13, the web service has been updated to allow a card with a token already registered in CMP to be added if the token is associated with a cancelled card that has the same card details as those provided in the request. This allows a previously cancelled card to be reinstated.
The POST Order web service has been enhanced to additionally support an upgrade order.
An upgrade order is where a price plan change and/or a number change can be requested.
An upgrade order may also include hardware details.
The upgrade order introduces a new container, subscriptionIdentifiers, that provides details or all subscriptions to upgrade with the associated hardware, price plan and/or serial number(s).
In addition, it is now possible to supply one or more non-managed serial numbers as part of a new subscription and an upgrade order.
The response of the GET Order web service has been updated to return the deviceEnrolmentStatus to make the response consistent with other order API responses.
The POST Subscription web service has been updated to allow one or more non-managed serial numbers to be provided as part of a new subscription creation request. In the response, the salespersonId has been changed to a salesperson object.
The response of the GET Subscription web service has been updated to return a salesperson object and an indication of whether the subscriber has an eSIM provisioned and if so, what the status of that eSIM is.
In addition a new object, identification, is also returned to show the identity held against the personal address of the subscription.
The object also contains information on when the identity was last blacklisted and/or whitelisted.
In a similar way to the GET Subscription response update, the GET Subscriptions web service response has also been updated to return the identity held against the personal address of each of the subscriptions returned.
The POST Subscription Attributes web service has been updated to now allow the specification of multiple attributes rather than just one.
The PATCH Subscription Email Address web service has been updated to allow an email address to be marked as the primary email address or marked as inactive.
The POST Payment web service has been updated to allow a purchase identifier to be recorded against an online payment.
The POST Price Plan web service has been updated to allow a non-network event, and associated action, to be raised. In CMP 8.12 this web service only supported network actions.
The PATCH Serial Numbers web service has been updated to allow a non-network event, and associated action, to be raised. In CMP 8.12 this web service only supported network actions.
No new Business Configuration RESTful web services have been introduced in CMP 8.13.
No RESTful web services have been updated as part of the CMP 8.13 release.
The CMP 8.13 release supports the second TM Forum API set around Payment Methods. This has been certified by the TM Forum against the TM670 API specification.
The provisioning adapter has been updated to additionally output the current base package of the price plan that the subscriber is subscribed to as part of the outbound provisioning message.
To support this change, an element basePackageCode has been added to the outbound provisioning JSON.
The NetEngage-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.
No changes have been made to the NetEngage adapter as part of CMP 8.13.
The Openet-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.
No changes have been made to the Openet adapter as part of CMP 8.13.
The Lifecycle-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.
No changes have been made to the Lifecycle adapter as part of CMP 8.13.
In CMP 8.12 the BACS ARUDD (Automated Return of Unpaid Direct Debits Service) transformation daemon logic resided in the sabre-recurring-bank-payments-bacs-adapter module.
For CMP 8.13, this logic has been moved to its own module, sabre-arudd-transformation-adapter.
The sabre-recurring-bank-payments-bacs-adapter module has therefore been deprecated in CMP 8.13.
In addition to functional and non-functional changes and improvements, the CMP 8.13 product also addresses a number of application support issues. This section provides a summary of the issues fixed in this release.
The following issues have been addressed within this release:
| Reference | Area | Description |
|---|---|---|
| CMPIS-2822 | Rated Usage | The rated usage job was failing for a multi-instance scenario when more than a single instance is in an active state. |
| CMPIS-2816 | Web Services | The customerCostCentre element was defined incorrectly in the POST Subscription request. It was documented correctly as costCentre. |
| CMPIS-2814 | AgentView | An internal system error was being returned in AgentView when the refresh button was used. |
| CMPIS-2811 | Web Services | The shipping address attributes in the REST Get Order Response were not defined in Camel Case. |
| CMPIS-2808 | AgentView | It was not possible to perform a Price Plan change through AgentView where the underlying tariff on the old and new price plan was the same. |
| CMPIS-2803 | Administration Console | Some of the properties deployed via the External Configuration module were appearing on the double in the System Property table. |
| CMPIS-2801 | Rated Usage | Some CDRs were being incorrectly loaded multiple times and therefore being rejected as duplicate records. |
| CMPIS-2787 | Web Services | The connectionEventCode attribute has been changed from mandatory to optional. |
| CMPIS-2782 | Web Services | The data returned in the upgradePossibleDate and earlyUpgradePossibleDate attributes in the REST Get Subscription response object were the wrong way around. |
| CMPIS-2781 | Purge & Archiving | A foreign key constraint on the orderDispatchSerialNumberBatchDetail table was preventing the table from being dropped and caused the Interface Purge job to fail. |
| CMPIS-2774 | Invoice Production | The prorate calculation using the actual days in the month was pricing incorrect when the charged traversed a month with different numbers of days. |
| CMPIS-2773 | Process Event | Where multiple account types were defined for an account charge usage of 'Charging Suspended', the charging suspension was not being handled correctly. |
| CMPIS-2763 | Web Services | If the SIM Serial Id system property was not defined, and internal server error was reported. A more meaningful error is now returned. |
| CMPIS-2761 | AgentView | In some cases, subscriptions that were out of contract were not appearing in the termination costs panel. |
| CMPIS-2758 | Business Configuration | In the Price Plan list view, the Edit button was not enabled to edit an existing Price Plan. |
| CMPIS-2757 | Payments | In some cases, when a refund was created against a payment the record that was subsequently created on the sales ledger transaction table did not contain the correct values for original transaction type and original transaction reference meaning the ledger monitor cannot match the refund against the payment. |
| CMPIS-2756 | Batch Jobs | When the Usage Reconcilliation job failed it would still be marked as complete so was hiding a fatal exception. |
| CMPIS-2755 | Database | The size of the UsageCharge field on the UsageReconcilliation table was too small causing the Usage Reconciliation job to fail. |
| CMPIS-2745 | Bulk Actions | It was observed in testing that a large number of events were being created for a single CMP account. This was due to the bulk action driver file not being correctly archived once processed. |
| CMPIS-2744 | Web Services | The SOAP QuerySubscription web service (with a dataset of 'BASIC') was returning a subscription status of 'Normal' in the response for a subscription that was barred. |
| CMPIS-2742 | Web Services | The dates returned for 'upgradePossibleDate' and 'earlyUpgradePossibleDate' in the Get Subscription response were incorrect by 1 day. |
| CMPIS-2735 | Payments | A credit value was observed to remain on an account after the refund had been processed. |
| CMPIS-2714 | Business Configuration | When adding a prepaid price plan, saving the record give a validation message saying that "Cannot configure contract with a prepaid price plan". |
| CMPIS-2713 | Rated Usage | The NetEngage usage adapter was not loading usages file to the inbound/usages location due to a deprecated method. |
| CMPIS-2711 | Advance Notification | The Prepaid Inactivity Advance Notification warning was not being triggered when the purchase effective date was past the warning time interval. |
| CMPIS-2679 | Web Services | The REST Get Subscription Response has been updated to include a salesperson object |
| CMPIS-2678 | Web Services | Some attributes in the REST Create Subscription request and response have been updated for consistency with other web services. |
| CMPIS-2677 | Web Services | Some attributes in the REST Create Order (New Subscription) request and response have been updated for consistency with other web services. |
| CMPIS-2676 | Web Services | The REST Get Orders Response has been updated to include a salesperson object |
| CMPIS-2675 | Web Services | Some attributes in the REST Get Order response have been updated for consistency with other web services. |
| CMPIS-2674 | Web Services | When using the Create Order REST web service, the "salespersonId" field was being interpreted as the sales account number. |
| CMPIS-2657 | Greenhouse Performance Testing | The performance of the Unbilled Usage Extract job was observed to degrade with a large volume of records. |
| CMPIS-2653 | Web Services | The customerContactName and customerContactNumber attributes in the Create Workflow web service request have been made optional. |
| CMPIS-2650 | Invoice Print | The batch record count for the Bill Print job was being recorded incorrectly. |
| CMPIS-2648 | Batch Jobs | Interface Batch Detail record were being marked incorrectly such that they could never be purged. |
| CMPIS-2642 | AgentView | It was not possible to amend the details of an agreement that was created through REST. |
| CMPIS-2618 | Batch Jobs | The Rated Usage job was incorrectly identifying records as duplicates. |
| CMPIS-2566 | Web Services | The Get Usages REST web service was reporting an unsupported operation exception when valid values for billingStatus.exact and invoiceId.exact were provided. |
| CMPIS-2556 | Business Configuration | Price Plans that were not assigned to a Price Plan Group were not being displayed in the list of price plans. |
The product documentation is available online on the documentation portal. This online portal requires authorised access, which can be obtained by contacting MDS Global support. The documentation is also available as downloadable PDFs as follows:
| Document | Version | Document Changes |
|---|---|---|
| Installation Guide | 1.0 | The Installation Configuration Tool topic has been updated to include the new AgentView branding function, which is now part of the installer. |
| Technical Architecture | 1.0 | There are no updates to the Technical Architecture Guide as part of CMP 8.13. |
| CMP Overview | 1.0 | An eSIM topic has been added, and the Credit Control topic updated to include Identity as part of the credit control procedure. |
| Documentation Overview | 1.0 | There are no updates to the Documentation Overview as part of CMP 8.13. |
| System Administration Guide | 1.0 | Reference to the sabre-recurring-bank-payments-bacs-adapter module has been removed as the module has been deprecated. |
| Security Guide | 1.0 | There are no updates to the Security Guide as part of CMP 8.13. |
| AgentView Function Security Guide | 1.0 | The function security related to the ability to bring an identity out of blacklist has been added to the AgentView Function Security Guide. |
| Operational Overview | 1.0 | There are no updates to the Operational Overview as part of CMP 8.13. |
| Business Configuration Overview | 1.0 | A section on Identity Management has been added to the Credit Management chapter. |
| Billing Functionality Guide | 1.0 | There are no updates to the Billing Functionality Guide as part of CMP 8.13. |
| Communications Functionality and Configuration Guide | 1.0 | There are no updates to the Communications Functionality and Configuration Guide as part of CMP 8.13. |
| Propositions Functionality and Configuration Guide | 1.0 | There are no updates to the Propositions Functionality and Configuration Guide as part of CMP 8.13. |
| Payments Functionality Guide | 1.0 | There are no updates to the Payments Functionality Guide as part of CMP 8.13. |
| Extracts Guide | 1.0 | There are no updates to the Extracts Guide as part of CMP 8.13. |
| Purge Guide | 1.0 | Tables have been renamed in the Purge Guide as part of CMP 8.13. |
| Standard Reporting | 1.0 | There are no updates to the Standard Reporting Guide as part of CMP 8.13. |
| Batch Jobs and JSON Schemas Guide | 1.0 | The Batch Jobs and JSON Schemas Guide has been updated to include the change to the provisioning job highlighted in section 3.8.1 above. |
| RESTFul Web Services API Guide | 1.0 | The REST web services guide has been updated based on the changes highlighted in section 3.7.1 above. |
| SOAP Web Services Semantics Guide | 1.0 | AddRegisteredCard and CancelRegisteredCard web services have been marked as deprecated. |
| Business Configuration RESTFul Web Services API Guide | 1.0 | There are no updates to the Business Configuration RESTFul web services guide as part of CMP 8.13. |
| Glossary | 1.0 | New terms relating to eSIM, porting and CXP have been added for CMP 8.13. |
Online help is available in AgentView, Business Configuration, the Administration Console and the Bulk Actions console. The following table summarises the current versions of the online help and the changes since CMP 8.12:
| Online Help | Version | Document Changes |
|---|---|---|
| AgentView | 1.3 | The following topics have been added or updated as a result of changes made to AgentView in CMP 8.13:
|
| Business Configuration | 1.17 | The following changes have resulted in changes to Business Configuration online help:
|
| Administration Console | 1.15 | There are no updates to the Administration Console as part of CMP 8.13. |
| Bulk Action Console | 1.7 | The following topics have been added in the Bulk Action Console help in CMP 8.13:
|
The CMP 8.13 installer includes the capability to upgrade a CMP 8.12 installation without the loss of configuration or customer data provided that the software, file system and database structure of the installation in question are at no point manually modified.
The CMP 8.13 Installation Guide, and the details below, should be read before attempting the upgrade to CMP 8.13.
It is important that the following sections are read prior to performing the upgrade, specifically the Configuration Changes section, as it may be advisable to backup relevant configuration prior to performing the upgrade to ensure the configuration can be replicated, if necessary, post upgrade.
As detailed in section 6.2 below, AgentView branding is now included within the installation configuration and therefore any existing customer branding will need to configured prior to an upgrade to ensure that existing AgentView branding will be retained.
It is important that the existing installation is left running before starting the upgrade. There is no reason to shut down any components however service may be affected whilst performing the upgrade.
The following changes have been made to the Installation Configuration Tool as part of CMP 8.13:
No third party libraries have been updated for CMP 8.13.
The following table has been added in CMP 8.13:
The following views have been added in CMP 8.13:
No table attributes have been added in CMP 8.13.
No tables or views have been dropped in CMP 8.13.
No table attributes have been dropped in CMP 8.13.
The following table attribute has been changed in CMP 8.13:
There are no new module properties that need to be configured following the upgrade to CMP 8.13.
The addition of the new Bulk Add Package option, as described in section 3.2.1 above, has introduced a new WSO2 role, bulk-add-package, that may need to be assigned to all users who have access to the Bulk Action Console.
CMP 8.13 has introducted the ability to send an end-user communication following the despatch of an order. This is driven through a workflow that needs to defined in the workflow properties table.
At present the workflow properties option of Business Configuration does not allow new properties to be added so the configuration below will need to be manually added to the workflowProperties table:
| Property Group | Property Name | Event Type | Event Code | Description |
|---|---|---|---|---|
| SALESORDER | order.dispatch.success | TBD | TBD | This workflow event properties entry controls the workflow that is raised when an order is successfully dispatched from a warehouse. |
The workflow event type and code that will be used on order despatch will also need to be configured through Business Configuration. Once configured, the event type and code will need to be added to the new workflow event properties table.
As part of a new installation, we need to be able to offer our customers the ability to deploy product data only associated with specific network codes rather than deploying all the product data associated with all networks supported. In CMP 8.13 only the data related to teh specific network(s) defined in the installation configuration tool will be deployed for a new installation.
